Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

types: add top level changelog, and share types across api nodes #938

Merged
merged 9 commits into from
May 29, 2024

Conversation

abvthecity
Copy link
Contributor

@abvthecity abvthecity commented May 29, 2024

  • move common types between docs v1 read, write, and db to commons.yml
  • creates a NavigationTabV2 which is a discriminated union
  • adds ChangelogSection to both the NavigationItem and NavigationTab levels
  • moves common properties to NavigationNodeMetadata and extend it everywhere (page, section, api, tab, changelog, etc.)
  • update AlgoliaSearchRecord generator to include changelogs on the section and tab levels, and ignore hidden pages.

This is largely a non-functional change that creates FDR types that can be consumed in the frontend and in the fern cli. Follow up PRs will be needed to publish the changelog (in Fern CLI) and render the changelog (in the UI)

@abvthecity abvthecity requested a review from dsinghvi as a code owner May 29, 2024 16:01
Copy link

vercel bot commented May 29, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
fern-dev ✅ Ready (Inspect) Visit Preview May 29, 2024 9:09pm
3 Ignored Deployments
Name Status Preview Updated (UTC)
fern-prod ⬜️ Ignored (Inspect) May 29, 2024 9:09pm
fontawesome-cdn ⬜️ Ignored (Inspect) May 29, 2024 9:09pm
private-docs ⬜️ Ignored (Inspect) May 29, 2024 9:09pm

Copy link

Copy link

Copy link

Copy link

Copy link

Copy link

Copy link

Copy link

Copy link

@abvthecity abvthecity merged commit a2968d6 into main May 29, 2024
20 checks passed
@abvthecity abvthecity deleted the ajiang/top-level-changelog branch May 29, 2024 21:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants